update ES env variable documentation #410
Merged
+6
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonhealy1
approved these changes
Jul 20, 2025
GrzegorzPustulka
pushed a commit
to GrzegorzPustulka/stac-fastapi-elasticsearch-opensearch
that referenced
this pull request
Jul 21, 2025
fixes incorrect or missing documentation for ES_USE_SSL, ES_VERIFY_CERTS, and ES_API_KEY **Description:** - README.md documentation has incorrect default values for ES_USE_SSL and ES_VERIFY_CERTS - The default values that are used can be found at: `./stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/config.py` and `./stac_fastapi/opensearch/stac_fastapi/opensearch/config.py` - Adds documentation for ES_API_KEY **PR Checklist:** - [X] Code is formatted and linted (run `pre-commit run --all-files`) - [X] Tests pass (run `make test`) - [X] Documentation has been updated to reflect changes, if applicable - [X] Changes are added to the changelog --------- Co-authored-by: Bennett Patrick Brixen <bpbrixe@sandia.gov> Co-authored-by: Jonathan Healy <jonathan.d.healy@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes incorrect or missing documentation for ES_USE_SSL, ES_VERIFY_CERTS, and ES_API_KEY
Description:
./stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/config.pyand./stac_fastapi/opensearch/stac_fastapi/opensearch/config.pyPR Checklist:
pre-commit run --all-files)make test)